/*-
 * #%L
 * Utility classes for BoneJ1 plugins
 * %%
 * Copyright (C) 2015 - 2023 Michael Doube, BoneJ developers
 * %%
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 * #L%
 */


package org.bonej.util;

import java.util.regex.Matcher;
import java.util.regex.Pattern;

/**
 * Utility methods for making lists of bones and guessing which bone is in an
 * image
 *
 * @author Michael Doube
 */
public final class BoneList {

	/**
	 * List of bone names
	 */
	// Only add new bone names to the END of this list
	private static final String[] boneList = { "unknown", "scapula", "humerus",
		"radius", "ulna", "metacarpal", "pelvis", "femur", "tibia", "fibula",
		"metatarsal", "calcaneus", "tibiotarsus", "tarsometatarsal", "sacrum" };

	private BoneList() {}

	/**
	 * Return the array of bone names
	 *
	 * @return array of bone names
	 */
	public static String[] get() {
		return boneList;
	}

	/** Return the boneID of a bone in boneList that matches the input string
	 *
	 * @param boneString a String with a name of a bone
	 * @return index of the corresponding bone in {@link #boneList}
	 */
	public static int guessBone(final CharSequence boneString) {
		int boneID = 0;
		for (int n = 0; n < boneList.length; n++) {
			final Pattern p = Pattern.compile(boneList[n], Pattern.CASE_INSENSITIVE);
			final Matcher m = p.matcher(boneString);
			if (m.find()) {
				boneID = n;
			}
		}
		return boneID;
	}
}
